Update Air Quality tutorial #4340
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
viambot
added
the
safe to build
1 task
npentrel
force-pushed
the
air-quality-tutorial
branch
from
7045c52 to
be8a8d8
Compare
JessamyT
reviewed
May 30, 2025
npentrel
force-pushed
the
air-quality-tutorial
branch
from
2a7049e to
c6e7b37
Compare
|
It looks like the following files may have been renamed. Please ensure you set all needed aliases: |
npentrel
force-pushed
the
air-quality-tutorial
branch
from
c6e7b37 to
d8c8af6
Compare
Co-authored-by: Jessamy Taylor <[email protected]>
npentrel
force-pushed
the
air-quality-tutorial
branch
2 times, most recently
from
8d41a60 to
255d2f1
Compare
npentrel
force-pushed
the
air-quality-tutorial
branch
from
255d2f1 to
6e1a00a
Compare
JessamyT
reviewed
Jul 23, 2025
|
|
||
| - [SDS011 Nova PM sensor](https://www.amazon.com/SDS011-Quality-Detection-Conditioning-Monitor/dp/B07FSDMRR5) | ||
| - If you choose to use a different air quality sensor, you may need to [create your own module](/operate/get-started/other-hardware/create-module/) implementing the [sensor API](/operate/reference/components/sensor/#api) for your specific hardware. | ||
| - One [SDS011 Nova PM sensors](https://www.amazon.com/SDS011-Quality-Detection-Conditioning-Monitor/dp/B07FSDMRR5) |
There was a problem hiding this comment.
Suggested change
| - One [SDS011 Nova PM sensors](https://www.amazon.com/SDS011-Quality-Detection-Conditioning-Monitor/dp/B07FSDMRR5) | |
| - A [SDS011 Nova PM sensor](https://www.amazon.com/SDS011-Quality-Detection-Conditioning-Monitor/dp/B07FSDMRR5) |
| - [SDS011 Nova PM sensor](https://www.amazon.com/SDS011-Quality-Detection-Conditioning-Monitor/dp/B07FSDMRR5) | ||
| - If you choose to use a different air quality sensor, you may need to [create your own module](/operate/get-started/other-hardware/create-module/) implementing the [sensor API](/operate/reference/components/sensor/#api) for your specific hardware. | ||
| - One [SDS011 Nova PM sensors](https://www.amazon.com/SDS011-Quality-Detection-Conditioning-Monitor/dp/B07FSDMRR5) | ||
| - If you choose to use a different air quality sensor, you may need to [create your own module](/operate/get-started/other-hardware/) implementing the [sensor API](/operate/reference/components/sensor/#api) for your specific hardware. | ||
| - A single-board computer (SBC) [capable of running `viam-server`](https://docs.viam.com/installation/) |
There was a problem hiding this comment.
Suggested change
| - A single-board computer (SBC) [capable of running `viam-server`](https://docs.viam.com/installation/) | |
| - A single-board computer (SBC) [capable of running `viam-server`](/operate/get-started/setup/) |
[ood nit]
|
|
||
| ## Decide how you will organize your fleet | ||
| In this section we'll set up one air sensing machine as our development device. |
There was a problem hiding this comment.
Suggested change
| In this section we'll set up one air sensing machine as our development device. | |
| In this section we'll set up one air sensing machine as our development device. | |
| Later in this tutorial, you will learn to provision multiple devices using {{< glossary_tooltip term_id="fragment" text="fragments" >}}. |
or something; this isn't obvious looking at the headings
|
|
||
| {{<imgproc class="aligncenter" src="/fleet/fleet.svg" declaredimensions=true alt="Tree diagram with three locations that belong to one organization. One location contains sub-location A containing two machines and sub-location B containing one machine. Each of the two other locations contains machines directly with no sub-locations." >}} | ||
| Click the dropdown in the upper-right corner of the **FLEET** page and use the **+** button to create a new {{< glossary_tooltip term_id="organization" text="organization" >}} for your air quality machine company. |
There was a problem hiding this comment.
Suggested change
| Click the dropdown in the upper-right corner of the **FLEET** page and use the **+** button to create a new {{< glossary_tooltip term_id="organization" text="organization" >}} for your air quality machine company. | |
| Click the dropdown in the upper-right corner of the **FLEET** page and use the **+** button to create a new {{< glossary_tooltip term_id="organization" text="organization" >}} representing your air quality machine company. |
This may also require a little more introduction--feels a bit odd to have them using the fleet organization system without explanation beyond tooltips (until later), but I guess it's fine if we're assuming business customers?
| You have some individual customers, for example Antonia, who have a sensor machine in their home, or perhaps one inside and one outside. | ||
| You have other customers who are businesses, for example RobotsRUs, who have two offices, one in New York and one in Oregon, with multiple sensor machines in each. | ||
| RobotsRUs wants to separate their sensor data by physical location, so you create a location for RobotsRUs and then create sub-locations to group their New York sensor machines and their Oregon machines. | ||
| If the computer does not already have a Viam-compatible operating system installed, follow the [operating system setup section of the Quickstart guide](/operate/get-started/setup/) to install a compatible operating system. |
There was a problem hiding this comment.
Suggested change
| If the computer does not already have a Viam-compatible operating system installed, follow the [operating system setup section of the Quickstart guide](/operate/get-started/setup/) to install a compatible operating system. | |
| If the computer does not already have a Viam-compatible operating system installed, follow the [prerequisite section of the setup guide]/operate/get-started/setup/#prerequisite-make-sure-you-have-a-supported-operating-system) to install a compatible operating system. |
since it doesn't say "quickstart," and i think this is a bit easier to understand
| Select the part status dropdown to the right of your machine's name on the top of the page. | ||
|
|
||
| Click the copy icon next to **Machine cloud credentials**. | ||
| Paste the machine cloud credentials into a file on your hard drive called FILE>viam.json</FILE>. |
There was a problem hiding this comment.
Suggested change
| Paste the machine cloud credentials into a file on your hard drive called FILE>viam.json</FILE>. | |
| Paste the machine cloud credentials into a file on your hard drive called <FILE>viam.json</FILE>. |
| } | ||
| ``` | ||
|
|
||
| Replace `"<FRAGMENT-ID>"` with the fragment ID from your fragment. |
There was a problem hiding this comment.
Suggested change
| Replace `"<FRAGMENT-ID>"` with the fragment ID from your fragment. | |
| Replace `<FRAGMENT-ID>` with the fragment ID from your fragment. |
[nit] since you don't replace the quote marks
Comment on lines
919
to
920
| <div id="emailform"></div> | ||
|
|
There was a problem hiding this comment.
Suggested change
| <div id="emailform"></div> |
Is it possible to remove this yet?
| You might try putting an air filter in your home or office and comparing the air quality data before you start running the filter with air quality after you have run the filter for a while. | ||
| Or, try sealing gaps around doors, and check whether your seal is working by looking at your dashboard. | ||
| You can now set up one or more air quality sensors for yourself or others and access them with your dashboard. | ||
| If you are selling your air quality sensing machines, they can also use your dashboard to view _their_ data. |
There was a problem hiding this comment.
Suggested change
| If you are selling your air quality sensing machines, they can also use your dashboard to view _their_ data. | |
| If you are selling your air quality sensing machines, users can use your dashboard to view _their_ data. |
| 6. Now, you can actually delete the entire config from your machine! | ||
| In the next section, you will replace it with the fragment you just created so that it gets updated alongside all your other machines when you update the fragment in the future. | ||
| Complete the following steps on your laptop or desktop. | ||
| You don't need to install or edit anything else on your machine's single-board computer (aside from `viam-server` which you already did); you'll be developing your TypeScript app from your personal computer and deploying it to Viam. |
There was a problem hiding this comment.
Still think this needs more specificity
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Merge after: viamrobotics/rdk#5150
https://deploy-preview-4340--viam-docs.netlify.app/tutorials/control/air-quality-fleet/
Relies on #4335
TODO: